home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / qbbs / co102.zip / CO.DOC < prev    next >
Text File  |  1992-06-11  |  12KB  |  246 lines
  1. ==========================================================================
  2.  
  3.                                 Crossover
  4.                           Current Version: 1.02
  5.  
  6.                   Door Language Interpreter for SuperBBS
  7.                   Copyright (c) 1990, 1992 by Alan Graff
  8.                   Distributed by Cross Connect Software
  9.  
  10. ==========================================================================
  11.  
  12. Author (Alan Graff) retains all benefits of copyright.  Author hereby grants
  13. all persons license to copy and distribute this software package subject to
  14. the following restrictions and limitations:
  15.  
  16.  1. All documentation must accompany the program.  The author's text may not
  17.     be altered.
  18.  
  19.  2. Removal of author's comments and/or credits from the compiled program
  20.     or support files is prohibited.
  21.  
  22.  3. No charge is to be made for this software package over and above just
  23.     and reasonable fees for copying, distribution, postage and/or handling
  24.     costs. In no case shall more than a total of $2.50 (US) be charged for
  25.     this software.  To those offering this software as a downloadable file
  26.     on a closed data system which requires membership fee or charges for
  27.     online time, said fees are not considered to be a part of the prior
  28.     mentioned charges; however in this case, no further charge may be
  29.     levied for access to the data.
  30.  
  31.  4. The file CO.KEY may not be distributed by anyone other than the author
  32.     or his representatives. If obtained from any other source it shall be
  33.     considered an illegal copy in violation of U.S. copyright law.
  34.  
  35.  5. Software support for registered owners may be discontinued by the
  36.     author at any time without notice.  Registration does not guarantee
  37.     that any future versions will operate properly with registration key.
  38.  
  39. ==========================================================================
  40. * Short summary of what Crossover is
  41. --------------------------------------------------------------------------
  42.  
  43. Crossover is a departure from the normal for most IBM compatible BBS doors.
  44. For this reason, it may be a little bit difficult to get the hang of it
  45. when you are first starting out.  It is basically a language interpreter
  46. that operates through the SuperBBS door system.  It lets you write a door
  47. program using an ASCII text editor to create the text file source code.
  48. The concept is very similar to using a BASIC interpreter from DOS although
  49. the commands are somewhat different.
  50.  
  51. I first saw the dot command language in Crossover used in a BBS program for
  52. Apple II computers.   Crossover will (or should) run just about any generic
  53. dot command file written for the Apple II with very few changes.  All of the
  54. Apple II dot commands are supported by the freeware version of Crossover with
  55. the exception of the "Password:" command.  A modified form of this command is
  56. supported by the registered version of Crossover.
  57.  
  58. =========================================================================
  59. * Registered Systems
  60. -------------------------------------------------------------------------
  61. If you send in the registration form (REGISTER.DOC) along with payment,
  62. you will be sent a small file named CO.KEY.  Placing this file in the
  63. same directory as CO.EXE will unlock the features of the registered version.
  64.  
  65. Version 1.02 uses a new key format.  Older versions will not operate with
  66. the new key, nor will old keys operate the new versions. If you registered
  67. a version issued prior to 1.02, please fill out and send in the registration
  68. form along with an explanation that you have already registered and a new key
  69. will be sent to you.  Fraudulent claims will be ignored...I know who has
  70. paid and who has not. ;-)
  71.  
  72. ==========================================================================
  73. * Running Crossover from SuperBBS
  74. --------------------------------------------------------------------------
  75. Create a subdirectory (any name will do) and place CO.EXE in that directory.
  76. Create a two line ASCII file named CO.CFG which contains two lines.  The
  77. first line should be the full path to your BBS exit file, the second line
  78. should be which node you are running the program on.  The file should normally
  79. look something like:
  80.  
  81.      C:\SUPERBBS
  82.      1
  83.  
  84. If you are a registered user, place the file CO.KEY which was sent to you
  85. in this directory also.  This will unlock the extra features of the registered
  86. version.
  87.  
  88. Now place your source file in the directory.  All source files MUST end
  89. with the extension .SOU for the program to work correctly.
  90.  
  91. Create a batch file in your main BBS directory to take you to that
  92. directory and run the program.  That file should look something like
  93. this:
  94.  
  95.  
  96.     REM Command line:  *C /C  MAZE.BAT
  97.      CD C:\SUPERBBS\CO
  98.      CO PETE
  99.      CD C:\SUPERBBS
  100.  
  101. *****************************************************************************
  102.  
  103. Note on multi-tasking operation:
  104. I have not tested this program for multi-tasking.  According to the author of
  105. the i/o routines, the DOS variable OUTBUFF should be turned on under this
  106. situation to speed up it's operation. Here is the batch file above modified
  107. for this case:
  108.  
  109. REM Command line:  *C /C  MAZE.BAT
  110. CD C:\SUPERBBS\CO
  111. SET OUTBUFF=ON
  112. CO PETE
  113. SET OUTBUFF=OFF
  114. CD C:\SUPERBBS
  115.  
  116. *****************************************************************************
  117.  
  118. Now, to run Crossover, either create a type 7 exit in your menu system
  119. with the command line *C /C FILENAME.BAT (where "FILENAME.BAT"
  120. is the name of your batch file to run the program), or install Crossover
  121. as a part of the door template system using the same command line.
  122.  
  123. ==========================================================================
  124. * Running Crossover on other BBS systems
  125. --------------------------------------------------------------------------
  126. I have very little information how well it will work with other BBS systems,
  127. but if your BBS creates a DORINFO1.DEF file, it should work with no problems.
  128.  
  129. ==========================================================================
  130. * How Crossover interprets the source files
  131. --------------------------------------------------------------------------
  132. Source files are standard "plain vanilla" ASCII text files that may be
  133. created with any ASCII text editor.  Embedded control characters created
  134. by some editors will not be interpreted correctly and may cause problems
  135. with Crossover.
  136.  
  137. For a full listing of all of the commands recognized by Crossover and how
  138. to use them in your source file, read the file CO-LANG.DOC.
  139.  
  140. Pass the name of the source file to Crossover in the DOS command line in
  141. your startup batch file as a parameter.  Source files must have the
  142. extension ".SOU" for the program to process them.  The extension may be
  143. included in the command line or omitted.  Crossover will furnish the
  144. correct extension if you forget.
  145.  
  146. Crossover examines the source file from the top down, scanning it one line
  147. at a time.
  148.  
  149. If the line examined does NOT contain a "dot" (ASCII character 46 [.]) in
  150. column 1, the program displays the line to the user and on the sysop's
  151. screen as well.
  152.  
  153. If a dot appears in column 1, the program processes the entire line as
  154. a command.  What happens is based on the characters that follow the dot.
  155.  
  156. If the command requires the creation of a buffer file, Crossover will
  157. create an output file using the same root file name as your source with
  158. the extension "ASC".
  159.  
  160. Depending on how your source code is structured, Crossover may (or may not)
  161. append the output file to the end of your source code file when the
  162. program ends.  (See the command ".NA" for more details on this)  This
  163. permits the source to be self-modifying.  If the output file is appended
  164. to the source, the output file is erased when Crossover closes, otherwise
  165. the output remains and is appended itself the next time Crossover is called.
  166.  
  167. Once the end-of-file is reached, Crossover closes and returns control to the
  168. BBS program or batch file that started it.
  169.  
  170. If you are using commands that permit users to add to the file such as
  171. the .UT command, you will need to keep a close watch on your program and
  172. edit it often so that it does not get out of control.  Those things can
  173. grow pretty fast if your door is a popular one!
  174.  
  175. Please remember that most of the dot commands are CASE SENSITIVE.  I have
  176. not yet documented which are and which aren't yet, so it is best to assume
  177. a command IS case sensitive unless you determine otherwise.
  178.  
  179. If this is a bit hard to follow, take a look at the file BBSLIST.SOU or one
  180. of the other source files that were included with this program and then run
  181. it with Crossover to see what it does.  I think the visual aid of seeing
  182. the source run will help a person understand it's operation more than
  183. anything else.
  184.  
  185. ==========================================================================
  186. * Miscellaneous info
  187. --------------------------------------------------------------------------
  188. Crossover was written in Turbo Pascal 6.0 and uses JPDoor for the BBS file
  189. interface, communications I/O and some other miscellaneous functions.
  190.  
  191. Origin of the dot command language used in Crossover is largely unknown
  192. except that it was found in an Apple II BBS program sold by a company which
  193. is no longer in business.  The legal status is not fully known, but the
  194. structure of the language is assumed to be in the public domain.
  195. Additional dot commands used exclusively by of Crossover to enhance the
  196. operation were conceived by Alan Graff and their structure is herewith
  197. contributed to the public domain.
  198.  
  199. The following names are copyrighted by their respective owners:
  200.  - Crossover, Alan Graff
  201.  - Turbo Pascal, Borland International
  202.  - SuperBBS, Aki Antman and Risto Virkalla <sp?>
  203.  - JPDoor, Motor City Software
  204.  - IBM, International Business Machines, Inc.
  205.  - Apple II, Apple Computers, Inc.
  206.  
  207. Thanks to:
  208.    My loving wife, Patsy, for letting me spend countless hours
  209.    away from the family while sitting at my keyboard creating
  210.    this program; Chris Bugosh (Compu-Link BBS) for offering to
  211.    beta the early versions; John Parlin (Motor City Software) for
  212.    creating JPDoor, without which the I/O would not have been
  213.    possible; Jennifer Murphy (Kitty City BBS) for her list of the
  214.    Apple II dot commands when I lost my doc's; and mostly thanks
  215.    to God for giving me the talent to be able to write this thing
  216.    in the first place.
  217.  
  218. Disclaimer
  219. ----------
  220.     I have tested Crossover on a AT 286 system with 640 KB RAM running
  221.     SuperBBS and have found no serious flaws in the program other than
  222.     may have been mentioned in this or accompanying documentation. If you
  223.     locate an undocumented error in the code, please contact me so that it
  224.     may be corrected in the next version. I have done my best to debug this
  225.     program. Although to my knowledge it should not cause undue harm to any
  226.     system if operated according to the instructions, Alan Graff and/or
  227.     Cross Connect Software will not be held responsible for any loss of
  228.     data or any damage to software or any damage to any hardware that might
  229.     be caused by the operation of this program.
  230.  
  231. Blatant plug for the author's system:
  232. ------------------------------------
  233.     CROSS CONNECT (614) 776-7136
  234.     Fidonet 1:2260/50
  235.     24 hour operation
  236.     Support of 300 to 9600 v.32
  237.     Minimum of 1200 baud required for downloads.
  238.  
  239.          Cross Connect Software
  240.          P.O. Box 131
  241.          Wheelersburg, OH 45694
  242.  
  243.  
  244. End of file
  245. -----------------------------------------------------------------------------
  246.